Resource OperationDefinition/FHIR Server from package hl7.fhir.uv.crmi#current (47 ms)

Resources that use this resource

CapabilityStatement
crmi-authoring-artifact-repository	CRMI Authoring Artifact Repository

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType" : "OperationDefinition",
  "id" : "crmi-approve",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition crmi-approve</b></p><a name=\"crmi-approve\"> </a><a name=\"hccrmi-approve\"> </a><a name=\"crmi-approve-en-US\"> </a><p>URL: [base]/ActivityDefinition/$approve</p><p>URL: [base]/ActivityDefinition/[id]/$approve</p><p>URL: [base]/CapabilityStatement/$approve</p><p>URL: [base]/CapabilityStatement/[id]/$approve</p><p>URL: [base]/CodeSystem/$approve</p><p>URL: [base]/CodeSystem/[id]/$approve</p><p>URL: [base]/CompartmentDefinition/$approve</p><p>URL: [base]/CompartmentDefinition/[id]/$approve</p><p>URL: [base]/ConceptMap/$approve</p><p>URL: [base]/ConceptMap/[id]/$approve</p><p>URL: [base]/ExampleScenario/$approve</p><p>URL: [base]/ExampleScenario/[id]/$approve</p><p>URL: [base]/GraphDefinition/$approve</p><p>URL: [base]/GraphDefinition/[id]/$approve</p><p>URL: [base]/ImplementationGuide/$approve</p><p>URL: [base]/ImplementationGuide/[id]/$approve</p><p>URL: [base]/Library/$approve</p><p>URL: [base]/Library/[id]/$approve</p><p>URL: [base]/Measure/$approve</p><p>URL: [base]/Measure/[id]/$approve</p><p>URL: [base]/Medication/$approve</p><p>URL: [base]/Medication/[id]/$approve</p><p>URL: [base]/MedicationKnowledge/$approve</p><p>URL: [base]/MedicationKnowledge/[id]/$approve</p><p>URL: [base]/MessageDefinition/$approve</p><p>URL: [base]/MessageDefinition/[id]/$approve</p><p>URL: [base]/NamingSystem/$approve</p><p>URL: [base]/NamingSystem/[id]/$approve</p><p>URL: [base]/OperationDefinition/$approve</p><p>URL: [base]/OperationDefinition/[id]/$approve</p><p>URL: [base]/PlanDefinition/$approve</p><p>URL: [base]/PlanDefinition/[id]/$approve</p><p>URL: [base]/Questionnaire/$approve</p><p>URL: [base]/Questionnaire/[id]/$approve</p><p>URL: [base]/SearchParameter/$approve</p><p>URL: [base]/SearchParameter/[id]/$approve</p><p>URL: [base]/StructureDefinition/$approve</p><p>URL: [base]/StructureDefinition/[id]/$approve</p><p>URL: [base]/StructureMap/$approve</p><p>URL: [base]/StructureMap/[id]/$approve</p><p>URL: [base]/Substance/$approve</p><p>URL: [base]/Substance/[id]/$approve</p><p>URL: [base]/TerminologyCapabilities/$approve</p><p>URL: [base]/TerminologyCapabilities/[id]/$approve</p><p>URL: [base]/TestScript/$approve</p><p>URL: [base]/TestScript/[id]/$approve</p><p>URL: [base]/ValueSet/$approve</p><p>URL: [base]/ValueSet/[id]/$approve</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>id</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The logical id of the artifact to approved. The server must know the artifact (e.g. it is defined explicitly in the server's artifacts)</p>\n</div></td></tr><tr><td>IN</td><td>approvalDate</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The date on which the artifact was approved. If one is not provided the system date will be used.</p>\n</div></td></tr><tr><td>IN</td><td>artifactAssessmentType</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td/><td><div><p>If a comment is submitted as part of the approval, this parameter denotes the type of artifact comment.</p>\n</div></td></tr><tr><td>IN</td><td>artifactAssessmentSummary</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The body of the comment.</p>\n</div></td></tr><tr><td>IN</td><td>artifactAssessmentTarget</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>The canonical url for the artifact being approved. The format is: [system]|[version] - e.g. http://loinc.org|2.56</p>\n</div></td></tr><tr><td>IN</td><td>artifactAssessmentRelatedArtifact</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>Optional supporting canonical URL / Reference for the comment.</p>\n</div></td></tr><tr><td>IN</td><td>artifactAssessmentAuthor</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>A Reference to a resource containing information about the entity applying the approval.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The Bundle result containing both the updated artifact and the ArtifactAssessment (Basic in R4) resource containing the Approval metadata</p>\n</div></td></tr></table><div><p>The approve operation supports the ability of a repository to record commentary on a specific state of an artifact in an ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resource by applying an approval. The artifact assessments which are added by the operation must reference a version of the artifact.</p>\n</div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-approve",
  "version" : "1.1.0-cibuild",
  "name" : "CRMIApprove",
  "title" : "CRMI Approve",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-08-29T03:38:40+00:00",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "The approve operation supports applying an approval to an existing artifact, regardless of status. The operation sets the _date_ and _approvalDate_ elements of the approved artifact, and is otherwise only allowed to create ArtifactAssessment (Basic or cqf-artifactComment extensions in R4) resources in the repository.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "approve",
  "comment" : "The approve operation supports the ability of a repository to record commentary on a specific state of an artifact in an ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resource by applying an approval. The artifact assessments which are added by the operation must reference a version of the artifact.",
  "resource" : [
    "ActivityDefinition",
    "CapabilityStatement",
    "CodeSystem",
    "CompartmentDefinition",
    "ConceptMap",
    "ExampleScenario",
    "GraphDefinition",
    "ImplementationGuide",
    "Library",
    "Measure",
    "Medication",
    "MedicationKnowledge",
    "MessageDefinition",
    "NamingSystem",
    "OperationDefinition",
    "PlanDefinition",
    "Questionnaire",
    "SearchParameter",
    "StructureDefinition",
    "StructureMap",
    "Substance",
    "TerminologyCapabilities",
    "TestScript",
    "ValueSet"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "id",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The logical id of the artifact to approved. The server must know the artifact (e.g. it is defined explicitly in the server's artifacts)",
      "type" : "string"
    },
    {
      "name" : "approvalDate",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The date on which the artifact was approved. If one is not provided the system date will be used.",
      "type" : "date"
    },
    {
      "name" : "artifactAssessmentType",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "If a comment is submitted as part of the approval, this parameter denotes the type of artifact comment.",
      "type" : "code"
    },
    {
      "name" : "artifactAssessmentSummary",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The body of the comment.",
      "type" : "string"
    },
    {
      "name" : "artifactAssessmentTarget",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The canonical url for the artifact being approved. The format is: [system]|[version] - e.g. http://loinc.org|2.56",
      "type" : "canonical"
    },
    {
      "name" : "artifactAssessmentRelatedArtifact",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Optional supporting canonical URL / Reference for the comment.",
      "type" : "uri"
    },
    {
      "name" : "artifactAssessmentAuthor",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A Reference to a resource containing information about the entity applying the approval.",
      "type" : "Reference"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The Bundle result containing both the updated artifact and the ArtifactAssessment (Basic in R4) resource containing the Approval metadata",
      "type" : "Bundle"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.